Manage Appointment API
Methods and endpoints
The Manage Appointment API allows you to check site visit and RFS (non-site visit) appointment availability, reserve site visits, schedule RFS appointments and retrieve appointment details.
The following methods and endpoints are included in this API.
| Endpoint description | Method and endpoint | Function |
|---|---|---|
| API asset version | GET /version | Retrieves the full version number of the API asset (major, minor and patch version numbers). |
| Obtain site visit appointment availability | GET /siteVisitAppointmentAvailability | Returns a list of available site visit appointment dates and times for the region. |
| Reserve site visit appointment | PUT /siteVisitAppointment | Reserves or updates an appointment for a specific site visit for an order. |
| Obtain site visit appointment details | GET /siteVisitAppointment | Returns the details of an existing site visit appointments for an order. |
| Obtain RFS appointment availability | GET /rfsAppointmentAvailability | Returns a list of available RFS appointment dates and times. |
| Update RFS appointment | PUT /rfsAppointment | Updates an RFS appointment for an order. This endpoint is supported from version 1.1 of the API. |
| Obtain RFS appointment details | GET /rfsAppointment | Returns the details of an existing RFS appointment for an order. |
Mandatory attributes
| Attribute | Endpoint | Description |
|---|---|---|
| orderId | /rfsAppointmentAvailability/rfsAppointment | Mandatory attribute for all RFS appointment endpoints. Used to confirm the order in which available appointment dates and times are being requested. |
| siteVisitId | /siteVisitAppointmentAvailability/siteVisitAppointment | Mandatory attribute for all Site Visit endpoint requests. Used to confirm the Site Visit ID for which available appointment dates and times are being requested. |
| siteVisitAppointment | /siteVisitAppointment | Mandatory attribute for the /siteVisitAppointment endpoint. Used to request appointment dates and times for an order.Represents a site visit appointment date time in the one of the following date/time formats:- YYYY-MM-DDTHH:MM:SS.SSSZ - YYYY-MM-DDTHH:MM:SSZ Note: A siteVisitAppointment must have a startDateTime and endDateTime. |
| rfsAppointmentType | /rfsAppointmentAvailability/rfsAppointment | Mandatory attribute for all RFS appointment endpoints. Depending on the order type requested in order feasibility, use one of the following values: - Connect - Disconnect. Used to update RFS appointments or get appointment details for orders with an RFS only. |
| rfsAppointmentDateTime | /rfsAppointment | Mandatory attribute for the /rfsAppointment endpoint. Used to request the appointment date and time for an order. Represents an RFS appointment date and time in the one of the following date/time formats:- YYYY-MM-DDTHH:MM:SS.SSSZ - YYYY-MM-DDTHH:MM:SSZ Note: rfsAppointmentDateTime only has a startDateTime. |
| siteVisitAppointment | /siteVisitAppointment | Mandatory attribute for the /siteVisitAppointment endpoint. Used to request appointment dates and times for an order.Represents a site visit appointment date time in the one of the following date/time formats:- YYYY-MM-DDTHH:MM:SS.SSSZ - YYYY-MM-DDTHH:MM:SSZ Note: A siteVisitAppointment must have a startDateTime and endDateTime. |
Additional Attributes
These additional attributes are also applicable to the Manage Appointment API:
| Attribute | Description |
|---|---|
| count | Number of available appointments |
| orderId | See mandatory attributes |
| orderType | Type of order |
| dateTime | Date time value in the format YYYY-MM-DDTHH:MM:SS.SSSZ OR YYYY-MM-DDTHH:MM:SSZ |
| startDateTime | Start date time value in the format YYYY-MM-DDTHH:MM:SS.SSSZ OR YYYY-MM-DDTHH:MM:SSZ |
| endDateTime | End date time value in the format YYYY-MM-DDTHH:MM:SS.SSSZ OR YYYY-MM-DDTHH:MM:SSZ |
| timeSlotFilterStartDateTime | Optional attribute for the /rfsAppointmentAvailability endpoint. Used to filter desired appointment time and dates for an order, in one of the following date/time formats:- YYYY-MM-DDTHH:MM:SS.SSSZ - YYYY-MM-DDTHH:MM:SSZ |
| timeSlotFilterEndDateTime | Optional attribute for the /rfsAppointmentAvailability endpoint. Used to filter desired appointment time and dates for an order, in one of the following date/time formats:- YYYY-MM-DDTHH:MM:SS.SSSZ - YYYY-MM-DDTHH:MM:SSZ |
| validateInterAppointmentLeadTime | Optional attribute for the /siteVisitAppointmentAvailability endpoint. Indicates if returned appointment dates and times adhere to those with a valid Inter-appointment lead time.Default value: True (if not provided as input). Learn more about Inter-appointments |
| siteVisitId | See mandatory attributes |
| siteVisitAppointmentType | Type of site visit appointment |
| availableSiteVisitAppointments | Available site appointments |
Note: For more information on all available resources, attributes, parameters, field types, length and other restrictions, see the API Specification.